package com.eelpo.cmmp.uac.dao;

import java.util.List;

import org.springframework.dao.DataAccessException;

import com.eelpo.cmmp.uac.dao.entity.TEntity;

/**
 * <pre>
 * 
 * 业务实体数据访问 接口定义
 * 
 * </pre>
 * 
 * @author <a href="mailto:Brian@eelpo.com">汪洪州</a>
 * @since 1.0
 */
public interface IEntityManageDao {
	/**
	 * 根据业务实体Id获取业务实体对象
	 * 
	 * @param id
	 *            业务实体ID
	 * @return 返回业务实体值对象
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public TEntity getEntityById(String id) throws DataAccessException;

	/**
	 * 根据业务实体code获取业务实体对象
	 * 
	 * @param code
	 *            业务实体code值
	 * @return 返回业务实体值对象
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public TEntity getEntityByCode(String code) throws DataAccessException;

	/**
	 * 检查业务实体是否已经存在
	 * 
	 * @param code
	 *            业务实体code值
	 * @return 返回布尔值，true表示已经存在，false表示不存在
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public boolean checkExist(String code) throws DataAccessException;

	/**
	 * 检查业务实体是否已经存在，用于修改业务实体
	 * 
	 * @param id
	 *            业务实体Id
	 * @param code
	 *            业务实体帐号
	 * @return 返回布尔值，true表示已经存在，false表示不存在
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public boolean checkExistByUpdate(String id, String code) throws DataAccessException;

	/**
	 * 新增业务实体
	 * 
	 * @param entity
	 *            业务实体对象
	 * @return 返回新增过的业务实体Id
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public String addEntity(TEntity entity) throws DataAccessException;

	/**
	 * 修改业务实体
	 * 
	 * @param entity
	 *            业务实体对象
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public void updateEntity(TEntity entity) throws DataAccessException;

	/**
	 * 根据Id删除业务实体
	 * 
	 * @param id
	 *            业务实体Id
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public void deleteEntity(String id) throws DataAccessException;

	/**
	 * 获取用户有权限操作的所有菜单实体
	 * 
	 * @return 返回所有启用的实体
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public List<TEntity> getMenuEntities() throws DataAccessException;

	/**
	 * 获取用户有权限操作的所有启用菜单实体
	 * 
	 * @param userId
	 *            用户ID
	 * @return 返回用户有权限操作的所有菜单实体
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public List<TEntity> getMenuEntities(String userId) throws DataAccessException;

}
